﻿//-----------------------------------------------------------------------
// <copyright file="GoatFieldConstants.cs" company="Nathan Miller">
// Copyright (c) Nathan Miller.
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
//-----------------------------------------------------------------------
namespace GoatGen.Object
{
    /// <summary>
    /// String constants used for properties in the Goat file.
    /// </summary>
    public static class GoatFieldConstants
    {
        /// <summary>
        /// Field name for the config field.
        /// </summary>
        public static readonly string ConfigFieldName = "$Config$";
        
        /// <summary>
        /// Type of field key string.
        /// </summary>
        public static readonly string TypeKey = "type";

        /// <summary>
        /// Default value key string.
        /// </summary>
        public static readonly string DefaultKey = "default";

        /// <summary>
        /// Min value key string.
        /// </summary>
        public static readonly string MinKey = "min";

        /// <summary>
        /// Max value key string.
        /// </summary>
        public static readonly string MaxKey = "max";

        /// <summary>
        /// Allow null value key string.
        /// </summary>
        public static readonly string StringAllowNullKey = "allowNull";

        /// <summary>
        /// Namespace key string.
        /// </summary>
        public static readonly string ConfigNamespaceKey = "namespace";

        #region Type strings

        /// <summary>
        /// Int type string.
        /// </summary>
        public static readonly string IntFieldType = "int";

        /// <summary>
        /// Float type string.
        /// </summary>
        public static readonly string FloatFieldType = "float";

        /// <summary>
        /// String type string.
        /// </summary>
        public static readonly string StringFieldType = "string";

        /// <summary>
        /// Matrix type string.
        /// </summary>
        public static readonly string MatrixFieldType = "Matrix2D";

        /// <summary>
        /// Size2d type string.
        /// </summary>
        public static readonly string SizeFieldType = "Size2D";

        /// <summary>
        /// ColorRGBA type string.
        /// </summary>
        public static readonly string ColorFieldType = "ColorRGBA";

        /// <summary>
        /// GUID type string.
        /// </summary>
        public static readonly string GUIDFieldType = "GUID";

        /// <summary>
        /// Config type string.
        /// </summary>
        public static readonly string ConfigFieldType = "config";

        #endregion
    }
}
